Updated Is "Migration Right for you?" page and some dependencies #10158
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
…cluded in a seperate migration patterns page. Updated checklist. Signed-off-by: Brian Presley <bjpres@amazon.com>
sumobrian
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
jugal-chauhan
approved these changes
Jun 30, 2025
There was a problem hiding this comment.
I approve of these changes as marked in the PR.
Note to include these in a follow-up PR based on 'Execution'
- Snapshots must include global cluster state (include_global_stateistrue)
- User should perform a successful console metadata migrate before performing console backfill start or else RFS will create new indices with default mappings on the target cluster.
- User should know when not to use Traffic Replayer during deployment
- Point users to our RFS CloudWatch Dashboard on Step 11 to help validate work done by RFS, during Execution
Signed-off-by: Brian Presley <bjpres@amazon.com>
AndreKurait
reviewed
Jul 3, 2025
| - If deploying Migration Assistant into an existing AWS VPC, you must configure VPC interface endpoints and IAM permissions for the following AWS services: | ||
| - **Amazon CloudWatch Logs** – for log ingestion from ECS tasks. | ||
| - **Amazon CloudWatch** – for metrics published during migration | ||
| - **Amazon Elastic Container Registry (ECR)** – for pulling container images. |
There was a problem hiding this comment.
is this enough detail for customers? there are two ECR endpoints
com.amazonaws.region.ecr.dkr and com.amazonaws.region.ecr.api, we need the former to pull images not the later
https://docs.aws.amazon.com/AmazonECR/latest/userguide/vpc-endpoints.html#ecr-setting-up-vpc-create
There was a problem hiding this comment.
This is a level of detail that should be included on another page. On this page I'd like customers to think about the access that they will need.
AndreKurait
reviewed
Jul 3, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
AndreKurait
reviewed
Jul 3, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
AndreKurait
reviewed
Jul 3, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
AndreKurait
reviewed
Jul 3, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
AndreKurait
reviewed
Jul 8, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
lewijacn
reviewed
Jul 8, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
lewijacn
reviewed
Jul 8, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
lewijacn
approved these changes
Jul 8, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Jul 10, 2025
_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
reviewed
Jul 10, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Jul 10, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Jul 10, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Naarcha-AWS
reviewed
Jul 10, 2025
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
approved these changes
Jul 10, 2025
Naarcha-AWS
added
backport 3.1
Editorial review
natebower
reviewed
Jul 10, 2025
_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md
Outdated
Show resolved
Hide resolved
_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md
Outdated
Show resolved
Hide resolved
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
| - If you choose to bring your own snapshot (that is, one not created by Migration Assistant), the following settings must be applied when creating the snapshot: | ||
| - `include_global_state: true` – Ensures that global cluster state is included. | ||
| - `compress: false` – Disables metadata compression, which is required for compatibility with Reindex-from-Snapshot. | ||
| - Shards up to **80 GiB** are supported by default. Larger shard sizes can be configured, except in **AWS GovCloud**, where 80 GiB is the maximum. |
There was a problem hiding this comment.
Suggested change
| - Shards up to **80 GiB** are supported by default. Larger shard sizes can be configured, except in **AWS GovCloud**, where 80 GiB is the maximum. | |
| - Shards of up to **80 GiB** are supported by default. Larger shard sizes can be configured, **except in AWS GovCloud (US)**, where 80 GiB is the maximum. |
| - `compress: false` – Disables metadata compression, which is required for compatibility with Reindex-from-Snapshot. | ||
| - Shards up to **80 GiB** are supported by default. Larger shard sizes can be configured, except in **AWS GovCloud**, where 80 GiB is the maximum. | ||
|
|
||
| ### Capture-and-replay |
There was a problem hiding this comment.
Suggested change
| ### Capture-and-replay | |
| ### Capture and Replay |
|
|
||
| ### Capture-and-replay | ||
|
|
||
| Capture-and-Replay has the following requirements: |
There was a problem hiding this comment.
Suggested change
| Capture-and-Replay has the following requirements: | |
| Capture and Replay has the following requirements: |
_migration-assistant/overview/is-migration-assistant-right-for-you.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Nathan Bower <nbower@amazon.com>
natebower
approved these changes
Jul 10, 2025
|
@sumobrian Please fix DCO so we can merge. Thanks! |
natebower
added
Done but waiting to merge
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 10, 2025
) * Restructured "Is Migration Assistant Right for you?" page. Signed-off-by: Brian Presley <bjpres@amazon.com> * Broke down limitation by component. Minor editorial changes. Signed-off-by: Brian Presley <bjpres@amazon.com> * Removed "Chossing migration approach" since it will be revised and included in a seperate migration patterns page. Updated checklist. Signed-off-by: Brian Presley <bjpres@amazon.com> * Updated requirements around VPC connectivity. Signed-off-by: Brian Presley <bjpres@amazon.com> * Updated list of Migration Assistant products to vale github action products list. * Added further breakdown of networking requirements Signed-off-by: Brian Presley <bjpres@amazon.com> * Moved limitations and assumptions Signed-off-by: Brian Presley <bjpres@amazon.com> * Removed Github issue reference for Kibana Signed-off-by: Brian Presley <bjpres@amazon.com> * Identify services that are only Capture-and-Replay Signed-off-by: Brian Presley <bjpres@amazon.com> * Added ALB to list of services. Updated verbiage for ELB. Signed-off-by: Brian Presley <bjpres@amazon.com> * Updated based on style-job suggestions. Signed-off-by: Brian Presley <bjpres@amazon.com> * Updated S3 verbiage Signed-off-by: Brian Presley <bjpres@amazon.com> * Remove duplicate compression bullet point. Signed-off-by: Brian Presley <bjpres@amazon.com> * Indicate that secrets manager is only used for basic auth creds. Signed-off-by: Brian Presley <bjpres@amazon.com> * Updated SSM verbiage replacing EC2 w/ ECS Signed-off-by: Brian Presley <bjpres@amazon.com> * Add writer edits Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Nathan Bower <nbower@amazon.com> --------- Signed-off-by: Brian Presley <bjpres@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 3a4bedf) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS
added a commit
that referenced
this pull request
Jul 10, 2025
) (#10206) * Restructured "Is Migration Assistant Right for you?" page. * Broke down limitation by component. Minor editorial changes. * Removed "Chossing migration approach" since it will be revised and included in a seperate migration patterns page. Updated checklist. * Updated requirements around VPC connectivity. * Updated list of Migration Assistant products to vale github action products list. * Added further breakdown of networking requirements * Moved limitations and assumptions * Removed Github issue reference for Kibana * Identify services that are only Capture-and-Replay * Added ALB to list of services. Updated verbiage for ELB. * Updated based on style-job suggestions. * Updated S3 verbiage * Remove duplicate compression bullet point. * Indicate that secrets manager is only used for basic auth creds. * Updated SSM verbiage replacing EC2 w/ ECS * Add writer edits * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review --------- (cherry picked from commit 3a4bedf) Signed-off-by: Brian Presley <bjpres@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Nathan Bower <nbower@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This update consolidates and improves content across multiple documentation pages related to Migration Assistant. Key changes include:
Replaces outdated and redundant prerequisites in the Getting Started guide with a link to “Is Migration Assistant right for you?” page.
Rewrites and clarifies the purpose of the “Is Migration Assistant right for you?” page:
Improves opening rationale
Introduces a new assumptions and limitations section grouped into General, Reindex-from-Snapshot, and Capture-and-Replay
Updates migration path matrix heading for clarity
Replaces hardcoded AWS Region list with a link to the authoritative AWS documentation
Renames “Supported components” section to “Supported features” and uses clearer column headers
Refactors checklist for conciseness and use-case alignment
Fixes ordering issue in the sidebar nav items list for the Overview section
Issues Resolved
https://opensearch.atlassian.net/browse/MIGRATIONS-2618
Version
N/A
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.